Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget.custom/CustomButtonWidget/Builder

Builder

class Builder(message: Text, onPress: Consumer<CustomButtonWidget>)

Builds a CustomButtonWidget

Author

fzzyhmstrs

Since

0.5.?

Parameters

message

Text the button label

onPress

Consumer<CustomButtonWidget> action to invoke when the button is clicked or activated

Constructors

Builder

constructor(onPress: Consumer<CustomButtonWidget>)

constructor(message: Text, onPress: Consumer<CustomButtonWidget>)

Functions

active

fun active(active: Boolean): CustomButtonWidget.Builder

Sets the active state of this button.

activeSupplier

fun activeSupplier(activeSupplier: Supplier<Boolean>): CustomButtonWidget.Builder

Sets the dynamic active state of this button.

build

fun build(): CustomButtonWidget

Builds a CustomButtonWidget instance

child

fun child(child: TooltipChild): CustomButtonWidget.Builder

Applies a TooltipChild to this button for passing additional tooltip info

dimensions

fun dimensions(x: Int, y: Int, width: Int, height: Int): CustomButtonWidget.Builder

Sets the XY position and width/height of this widget. Defaults are position 0, 0 and 150w x 20h

height

fun height(height: Int): CustomButtonWidget.Builder

Sets the height of this widget. Default value is 20

messageSupplier

fun messageSupplier(messageSupplier: Supplier<Text>): CustomButtonWidget.Builder

Sets the dynamic label text this button.

narrationAppender

fun narrationAppender(narrationAppender: Consumer<NarrationMessageBuilder>): CustomButtonWidget.Builder

Applies a narration appender to this widget for adding narrations on top of the standard button narrations. Default is none.

narrationSupplier

fun narrationSupplier(narrationSupplier: CustomButtonWidget.ActiveNarrationSupplier): CustomButtonWidget.Builder

fun ~~narrationSupplier~~(narrationSupplier: ButtonWidget.NarrationSupplier): CustomButtonWidget.Builder

Applies a narration supplier to this widget. Default is the standard supplier for buttons, which narrates the button as "Message button"

noMessage

fun noMessage(): CustomButtonWidget.Builder

Disables rendering of the label provided to the button

position

fun position(x: Int, y: Int): CustomButtonWidget.Builder

Positions the widget in both x and y. Default is 0, 0

size

fun size(width: Int, height: Int): CustomButtonWidget.Builder

Sets the width and height of this widget. Default is 150w x 20h

texture

fun texture(tex: Identifier): CustomButtonWidget.Builder

Defines the texture for rendering the button background. The sprite rendered will not change based on object state.

textures

fun textures(textures: TextureSet): CustomButtonWidget.Builder

fun textures(tex: Identifier, disabled: Identifier, highlighted: Identifier): CustomButtonWidget.Builder

Defines the texture set used for rendering the button background

tooltip

fun tooltip(tooltip: Tooltip?): CustomButtonWidget.Builder

Applies a Tooltip to this widget. Default is null

fun tooltip(tooltip: Text?): CustomButtonWidget.Builder

Applies the provided text as a Tooltip to this widget. Default is null

tooltipSupplier

fun tooltipSupplier(tooltipSupplier: Function<Boolean, Text>): CustomButtonWidget.Builder

A tooltip supplier for this widget. Default is null

width

fun width(width: Int): CustomButtonWidget.Builder

Sets the width of this widget. Default value is 150